<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>My Engine: my::EventHandling Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">My Engine
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>my</b>      </li>
      <li class="navelem"><a class="el" href="classmy_1_1_event_handling.html">EventHandling</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">my::EventHandling Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="my::EventHandling" -->
<p>Pure Virtual class that provide a simple Signal/Slot system.<br/>
 A Signal is a string and a Slot is a function, connected to each other.  
 <a href="classmy_1_1_event_handling.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_event_handling_8h_source.html">EventHandling.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for my::EventHandling:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classmy_1_1_event_handling.png" usemap="#my::EventHandling_map" alt=""/>
  <map id="my::EventHandling_map" name="my::EventHandling_map">
<area href="classmy_1_1_triggering_timer.html" title="Create a TriggeringTimer. A TriggeringTimer is a Timer that call a binded slot (function or class mem..." alt="my::TriggeringTimer" shape="rect" coords="0,56,123,80"/>
</map>
 </div></div>

<p><a href="classmy_1_1_event_handling-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e95fb0bf933d8fcb4d4656a6a131528"></a><!-- doxytag: member="my::EventHandling::EventHandling" ref="a7e95fb0bf933d8fcb4d4656a6a131528" args="()" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmy_1_1_event_handling.html#a7e95fb0bf933d8fcb4d4656a6a131528">EventHandling</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor, does nothing. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8493a6d95e1408e6e22a57a1901f7024"></a><!-- doxytag: member="my::EventHandling::~EventHandling" ref="a8493a6d95e1408e6e22a57a1901f7024" args="()" -->
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmy_1_1_event_handling.html#a8493a6d95e1408e6e22a57a1901f7024">~EventHandling</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual default destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmy_1_1_event_handling.html#a3d8eb9c966885439a3f650104857a1f1">connect</a> (const std::string &amp;signal, my::slot function)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect a signal to a slot. When this signal is emitted with emit(std::string signal) the slot is called. Only one slot per signal is admitted.  <a href="#a3d8eb9c966885439a3f650104857a1f1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmy_1_1_event_handling.html#af68416478fe32516234b3a5979277aa3">emit</a> (const std::string &amp;signal)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Emit a signal, the associated Slot will be called.  <a href="#af68416478fe32516234b3a5979277aa3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmy_1_1_event_handling.html#a5f23ac57642f5d77b473d5fb63e603f4">disconnect</a> (const std::string &amp;signal)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnect a signal from a slot.  <a href="#a5f23ac57642f5d77b473d5fb63e603f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a255e835a06ff72922f2a777f12150a61"></a><!-- doxytag: member="my::EventHandling::clear" ref="a255e835a06ff72922f2a777f12150a61" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmy_1_1_event_handling.html#a255e835a06ff72922f2a777f12150a61">clear</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Will remove all signals. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5826c3fcce0e0ed2df67bcb35d83b62"></a><!-- doxytag: member="my::EventHandling::_table" ref="ac5826c3fcce0e0ed2df67bcb35d83b62" args="" -->
std::map&lt; std::string, my::slot &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_table</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Pure Virtual class that provide a simple Signal/Slot system.<br/>
 A Signal is a string and a Slot is a function, connected to each other. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3d8eb9c966885439a3f650104857a1f1"></a><!-- doxytag: member="my::EventHandling::connect" ref="a3d8eb9c966885439a3f650104857a1f1" args="(const std::string &amp;signal, my::slot function)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void my::EventHandling::connect </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>signal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">my::slot&#160;</td>
          <td class="paramname"><em>function</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Connect a signal to a slot. When this signal is emitted with emit(std::string signal) the slot is called. Only one slot per signal is admitted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">signal</td><td>The signal, under std::string form </td></tr>
    <tr><td class="paramname">function</td><td>The function to call when the signal is emitted. A slot is a function like void(void) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5f23ac57642f5d77b473d5fb63e603f4"></a><!-- doxytag: member="my::EventHandling::disconnect" ref="a5f23ac57642f5d77b473d5fb63e603f4" args="(const std::string &amp;signal)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void my::EventHandling::disconnect </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>signal</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Disconnect a signal from a slot. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">signal</td><td>The signal to remove </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="af68416478fe32516234b3a5979277aa3"></a><!-- doxytag: member="my::EventHandling::emit" ref="af68416478fe32516234b3a5979277aa3" args="(const std::string &amp;signal)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void my::EventHandling::emit </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>signal</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Emit a signal, the associated Slot will be called. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">signal</td><td>The signal to emit, under std::string form </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>System/<a class="el" href="_event_handling_8h_source.html">EventHandling.h</a></li>
<li>EventHandling.cpp</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Fri Nov 18 2011 22:34:34 for My Engine by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
